Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial markdowns small fixes #295

Merged
merged 3 commits into from
Jul 21, 2023
Merged

Tutorial markdowns small fixes #295

merged 3 commits into from
Jul 21, 2023

Conversation

Andrei-Aksionov
Copy link
Collaborator

Pretty small fixes for markdown files:

  1. MD009 - Trailing spaces.
    Rationale: Except when being used to create a line break, trailing whitespace has no purpose and does not affect the rendering of content.
  2. MD031 - Fenced code blocks should be surrounded by blank lines.
    Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse fenced code blocks that don't have blank lines before and after them.
  3. MD034 - Bare URL used.
    Rationale: Without angle brackets, a bare URL or email isn't converted into a link by some Markdown parsers.
  4. MD040 - Fenced code blocks should have a language specified
    Rationale: Specifying a language improves content rendering by using the correct syntax highlighting for code. More information: https://cirosantilli.com/markdown-style-guide#option-code-fenced.

@@ -24,6 +24,7 @@ To reduce the memory requirements further, Lit-GPT supports several quantization
Enabled with [bitsandbytes](https://github.com/TimDettmers/bitsandbytes). Check out the [paper](https://arxiv.org/abs/2305.14314v1) to learn more about how it works.

> **Note**: `bitsandbytes` only supports `CUDA` devices and the `Linux` operating system.
Windows users should use [WSL2](https://learn.microsoft.com/en-us/windows/ai/directml/gpu-cuda-in-wsl).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like one of the users with a Windows machine managed to run bnb inside WSL2 (which is basically a Linux in a VM).

Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice finds

@carmocca carmocca merged commit 67e5257 into Lightning-AI:main Jul 21, 2023
@Andrei-Aksionov Andrei-Aksionov deleted the markdown_chores branch July 22, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants